Refactor (packages/app/src/components/dialog-custom-provider-form.ts): Function with high complexity - #64
Open
MidnightEmoClub wants to merge 3 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
P1B: Starter Task: Refactoring PR
Use this pull request template to briefly answer the questions below in one to two sentences each.
Feel free to delete this text at the top after filling out the template.
1. Issue
Link to the associated GitHub issue: #14
Full path to the refactored file:
packages/app/src/components/dialog-custom-provider-form.tsWhat do you think this file does?
Validates the "Add custom provider" dialog form and builds the provider config object when the form is valid.
What is the scope of your refactoring within that file?
validateCustomProvider()Which Qlty‑reported issue did you address?
Function with high complexity (count = 31) in
validateCustomProvider()2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
validateCustomProvider()was a ~100-line monolith that contains trimming, parsing, and validation of three separate domains (top-level fields, model rows, header rows), making the logic hard to read, test, and reuse.What changes did you make to resolve the issue?
I extracted the three domain-specific logics into focused helpers —
validateBase(),validateModels(), andvalidateHeaders(), so the main function became a short composition of three callsHow do your changes improve maintainability? Did you consider alternatives?
Each helper now focuses on one validation domain with a clear contract (independently readable, testable, and reusable), while the main function is pure composition with no duplicated trim/config logic.
I considered writing a universal validation function for both the
modelsandheaders. However, they have slightly different validation logic (empty row handling, case-sensitivity, and field naming), so it would be overcomplicated to implement validation logic in one function.3. Validation
How did you validate that the change is correct?
bun typecheckfor syntax checkbunx oxlint packages/app/src/components/dialog-custom-provider-form.tsfor lint test (nobun lintbecause it seems that there are other files in the repo that could not pass the lint test)bun test ./src/components/dialog-custom-provider.test.tsUnit test for this moduleAttach a screenshot of the test coverage showing the lines were executed by the tests.

Attach a screenshot showing the tests that cover the change passing during CI

Attach a screenshot of

qlty smells --no-snippets <full/path/to/file.ts>showing fewer reported issues after the changes.